Skip to main content

DescribeBlockSwitchs

Description

query the current blocking switch list status information in DDoS settings.

Request Method

POST

Request Path

/apsara/route/Ddosprivate/DescribeBlockSwitchs

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
PageSizeBODYintegerNoNo sample value for this parameter.specifies the maximum number of records displayed on the page.
CurrentPageBODYintegerNoNo sample value for this parameter.specifies the current page number returned.
regionIdBODYstringYesNo sample value for this parameter.region id
versionBODYstringNo2016-01-01version of api

Return data

NameTypeSample valueDescription
TotalCountintegerno demo valuereturns the total number of pages.
Descriptionstringno demo valuebrief description of the blocking switch.
RequestIdstringno demo valuerequest ID.
PageSizeintegerno demo valuepage displays the maximum number of records.
CurrentPageintegerno demo valuecurrently returns page number.
Modeintegerno demo valueThe state of the blocking switch, including: 0: indicates closed state 1: indicates open state
ModeNamestringno demo valueThe status name of the blocking switch, including: closed turned on
BlockSwitchsarrayno demo valueBlocking switch list information. For specific sub-item descriptions, see the following parameter descriptions.
Idintegerno demo valueblock switch ID.
Codestringno demo valueblock switch code, used to identify the uniqueness of this parameter.
Namestringno demo valuethe name of the blocking switch.

Example

Successful Response example

{
"TotalCount":"no demo value",
"Description":"no demo value",
"RequestId":"no demo value",
"PageSize":"no demo value",
"CurrentPage":"no demo value",
"Mode":"no demo value",
"ModeName":"no demo value",
"BlockSwitchs":"no demo value",
"Id":"no demo value",
"Code":"no demo value",
"Name":"no demo value"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}